home *** CD-ROM | disk | FTP | other *** search
/ The Games Machine 131 / XENIATGM131.iso / Goodies / I-WAR 2 Egde of Chaos - New SDK / IW2-EOC_Pog_Scripting_SDK.exe / include / Subsim.h < prev    next >
C/C++ Source or Header  |  2002-01-14  |  2KB  |  87 lines
  1. //
  2. // (c) 1999 Particle Systems Ltd. All Rights Reserved
  3. //
  4. // Subsim.h
  5. //
  6. // Flux subsim package API.
  7. //
  8. // Revision control information:
  9. //
  10. // $Header: /flux/packages/Subsim.h 6     8/09/00 11:55 Brett $
  11. //
  12.  
  13. // Handle definition /////////////////////////////////////////////////////////
  14.  
  15. #include "Flux.h"
  16.  
  17. #ifdef FLUX_COMPILE
  18.  
  19. FLUX_DECLARE_EXTENSION(SubSim);
  20.  
  21. #ifdef FLUX_LIB
  22. #if _MSC_VER >= 1000
  23. #pragma comment( lib, "subsim" )
  24. #endif // _MSC_VER >= 1000
  25. #endif // FLUX_LIB
  26. #else
  27.  
  28. // The handle to a subsim
  29. handle hsubsim : hobject;
  30.  
  31. uses Object;
  32.  
  33. //
  34. // prototype hsubsim Subsim.Cast( hobject object )
  35. //
  36. // Casts the object to a subsim
  37. //
  38. prototype hsubsim Subsim.Cast( hobject obj );
  39.  
  40. //
  41. // prototype hsubsim Subsim.Create( string template )
  42. //
  43. // Creates a new subsim from the template.
  44. //
  45. prototype hsubsim Subsim.Create( string template);
  46.  
  47. //
  48. // prototype Subsim.Place( hsubsim subsim, float x, float y, float z)
  49. //
  50. // Places the subsim at the given position on its sim.  This function will
  51. // complain if the subsim has not been attached yet.
  52. //
  53. prototype Subsim.Place( hsubsim subsim, float x, float y, float z);
  54.  
  55. //
  56. // prototype Subsim.Orientate( hsubsim subsim, float x, float y, float z)
  57. //
  58. // Orientates the subsim relative to its sim by the given Euler angles.  
  59. // This function will complain if the subsim has not been attached yet.
  60. //
  61. prototype Subsim.OrientateEuler( hsubsim subsim, float yaw, float pitch, float roll);
  62.  
  63. //
  64. // prototype hsubsim Subsim.Create( string template, string name )
  65. //
  66. // Creates a new subsim from the template and the given name.
  67. //
  68. prototype Subsim.Preload( string template );
  69.  
  70. //
  71. // prototype Subsim.Destroy( hsubsim subsim )
  72. //
  73. // Destroys the subsims (removes it from any ship it is in automatically).
  74. //
  75. prototype Subsim.Destroy( hsubsim subsim );
  76.  
  77. //
  78. // prototype hsim Subsim.Sim( hsubsim subsim )
  79. //
  80. // Returns a handle to the sim on which we are situated.
  81. //
  82. prototype hsim Subsim.Sim( hsubsim subsim );
  83.  
  84. // EOF ///////////////////////////////////////////////////////////////////////
  85.  
  86. #endif // FLUX_LIB
  87.